<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<title>Proxima Inspector</title>
		<link rel="icon" href="../icons/favicon.ico" />
		<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1">
		<meta property="og:type" content="website">
		<meta name="description" property="og:description" content="Proxima Inspector lets you connect to your live game from a web browser to inspect and edit any property. Just like the Unity editor!">
		<meta name="image" property="og:image" content="../images/proxima-1200x630.png">
		<meta http-equiv="content-security-policy" content="">
		<link href="../_app/immutable/assets/_layout-1f0a7e97.css" rel="stylesheet">
		<link href="../_app/immutable/assets/_layout-6847360b.css" rel="stylesheet">
		
		
		
		
		
		
		
		
		
		
		
	</head>
	<body>
		<div>


<div class="flex flex-col items-center text-gray-300 w-full min-h-screen bg-[#222]"><div class="flex w-full justify-center items-start bg-[#111] text-white fixed z-20"><div class="flex grow justify-between items-center max-w-[1600px] p-4"><a href="https://www.unityproxima.com"><img src="../images/proxima_logo.png" class="w-[150px]" alt="Logo"></a>
            <button class="lg:hidden"><img class="w-10" src="../icons/menu.png" alt="Menu"></button>
            <div class="flex gap-10 items-center max-lg:hidden">
<a href="https://assetstore.unity.com/publishers/72095?aid=1101lqSYn" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Store</a>
                
<a href="https://app.unityproxima.com/connection" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Demo</a>
                
                <a class="text-xl font-logo" href="../docs.html">Docs</a>
                
<a href="https://discord.gg/VM9cWJ9rjH" class="" referrerpolicy="origin" target="_blank" rel="external"><img width="100px" class="mt-1" src="../icons/discord.png" alt=""></a></div></div>
        </div>

    <div class="pt-[83px] w-full h-full flex flex-col items-center"><div class="w-full flex flex-col items-start min-h-screen max-w-[1600px] px-4"><button class="text-white font-body pt-5 lg:hidden">Go to page &gt;</button>
    <div class="flex w-full min-h-full relative"><div class="h-full fixed border-r-orange-400 bg-[#222] border-r-2 max-lg:hidden"><div class="flex pt-10 flex-col w-[300px] gap-2 border-[#21a6f0] min-h-0 h-full overflow-auto"><b class="text-orange-400">Getting Started</b>
                <a href="../docs.html" class="svelte-yue6wq">Installation</a>
                <a href="../docs/features.html" class="svelte-yue6wq">Feature Overview</a>

                <b class="text-orange-400 mt-5">Connection</b>
                <a href="../docs/supported_platforms.html" class="svelte-yue6wq">Supported Platforms</a>
                <a href="../docs/connect.html" class="svelte-yue6wq">Connect to Your Game</a>
                <a href="../docs/security.html" class="svelte-yue6wq">Security Considerations</a>
                <a href="../docs/all_config.html" class="svelte-yue6wq">All Configuration Options</a>

                <b class="text-orange-400 mt-5">Inspector</b>
                <a href="../docs/inspector.html" class="svelte-yue6wq">GameObject Inspector</a>
                <a href="../docs/buttons.html" class="svelte-yue6wq">Adding Buttons</a>
                <a href="../docs/faq.html" class="svelte-yue6wq">Frequently Asked Questions</a>

                <b class="text-orange-400 mt-5">Logs</b>
                <a href="../docs/logs.html" class="svelte-yue6wq">Log Viewer</a>
                <a href="../docs/viewing_logs_offline.html" class="svelte-yue6wq">Viewing Logs Offline</a>

                <b class="text-orange-400 mt-5">Console</b>
                <a href="../docs/console.html" class="svelte-yue6wq">Console Window</a>
                <a href="../docs/console_built_in.html" class="svelte-yue6wq">Built-in Commands</a>
                <a href="../docs/console_custom.html" class="svelte-yue6wq">Custom Commands</a>

                <b class="text-orange-400 mt-5">Extras</b>
                <a href="../docs/deeplinks.html" class="svelte-yue6wq">Deep Links</a>

                <div class="h-[200px] shrink-0"></div></div></div>

        
        <div class="flex flex-col w-full lg:pl-10 py-10 lg:ml-[300px]"><div class="doc flex flex-col gap-5 svelte-yue6wq"><h1>Console</h1>

<h2>Basic Usages</h2>
<p>The Proxima Console gives you a powerful command line utility to remotely inspect and control your game.
   The Console comes with several built-in commands, and you can
   write your own commands with unlimited potential.</p>

<img src="../docs/console.png" alt="Proxima Console">

<h2 class="text-zing-100 text-xl mt-5">Using the Console</h2>
<ul class="list-disc ml-5"><li>Type <b>&#39;?&#39;</b> to see a list of all commands.</li>
   <li>Type <b>&#39;? &lt;command&gt;&#39;</b> to see more information about a command.</li>
   <li>Type <b>&#39;h&#39;</b> to see your history of commands.</li>
   <li>Press the <b>Up</b> and <b>Down</b> arrows to cycle through your history of commands.</li>
   <li>Type some characters and press <b>Tab</b> to cycle through auto-completion options.</li></ul>

<h2 class="text-zing-100 text-xl mt-5">Examples</h2>
<div class="bg-[#1d1d1d] p-3 text-zinc-300 font-mono"><span class="text-gray-400">// List all gameObjects starting with cube</span><br>
   &gt; list cube*<br>
   Cube (1) [25654]<br>
   Cube (2) [25664]<br>
   Cube (3) [25634]<br>
   <br>
   <span class="text-gray-400">// Get the position of a specific cube</span><br>
   &gt; get [25654].transform.position<br>
   Cube (1) [25654] [1, 2, 3]<br>
   <br>
   <span class="text-gray-400">// Move the cube</span><br>
   &gt; move [25654] [0, 3, 0]<br>
   Moved Cube (1) [25654] to [0, 3, 0]<br>
   <br>
   <span class="text-gray-400">// Rotate the camera to look at the cube</span><br>
   &gt; lookat &quot;Main Camera&quot; [25654].transform.position<br>
   Rotated Main Camera [23438] to [0, 3, 0]<br>
   <br>
   <span class="text-gray-400">// Add a RigidBody component to the cube</span><br>
   &gt; addcomponent [25654] rigidbody<br>
   Added Rigidbody to Cube (1) [25654]<br>
   <br>
   <span class="text-gray-400">// Destroy all the cubes</span><br>
   &gt; destroy cube*<br>
   Destroyed Cube (1) [25654]<br>
   Destroyed Cube (2) [25664]<br>
   Destroyed Cube (3) [25634]<br>
   <br>
   <span class="text-gray-400">// Enter fullscreen</span><br>
   &gt; set screen.fullscreen true<br>
   Set Screen.fullScreen to true<br>
   <br>
   <span class="text-gray-400">// Slow down time by half</span><br>
   &gt; set time.timescale 0.5<br>
   Set Time.timeScale to 0.5<br>
   <br>
   <span class="text-gray-400">// Change TextMeshPro text</span><br>
   &gt; set text1.textmeshpro.text &quot;banana phone&quot;<br>
   Set Text1.TextMeshPro.Text to banana phone<br></div>

<h2 class="text-zing-100 text-xl mt-5">Pattern Matching</h2>
<p>Several built-in commands support pattern matching for gameObjects and properties:</p>
<ul class="ml-5 list-disc"><li>Use asterisk (*) to as a wildcard to when specifying gameObjects. For example: cube* will match cube1 and cube23</li>
   <li>Use dot notation to reference properties. For example: cube1.transform.position</li>
   <li>Many commands print the gameObject&#39;s ID. You can use this ID instead of the name. For example: [25654].transform.position</li></ul>

<h2 class="text-zing-100 text-xl mt-5">Types</h2>
<p>Proxima Commands can process these types: bool, int, uint, float, string, Vector2, Vector2Int, Vector3, Vector3Int, Quaternion, Vector4, Rect, RectInt, Bounds, BoundsInt, Color, Enum, Array.</p>
<ul class="list-disc ml-5"><li>To pass bool use <b>true</b> or <b>false</b></li>
    <li>To pass string use quotes: <b>&quot;The quick brown fox&quot;</b>.</li>
    <li>To pass Vector2, Vector3, or Vector4: <b>[1.1, 2.2, 3.3]</b> means <b>new Vector3(1.1, 2.2, 3.3)</b>.</li>
    <li>To pass Quaternion: <b>[10, 20, 30]</b> means <b>Quaternion.Euler(10, 20, 30)</b>.</li>
    <li>To pass Rect: <b>[1, 2, 3, 4]</b> means <b>new Rect(1, 2, 3, 4)</b>.</li>
    <li>To pass Bounds: <b>[1, 2, 3, 4, 5, 6]</b> means <b>new Bounds(new Vector3(1, 2, 3), new Vector3(4, 5, 6))</b>.</li>
    <li>To pass Color use hexidecimal format: <b>#FF0000</b> means red.</li>
    <li>You can also pass an array of the same type to a List or Array C# parameter, for example, <b>[1, 2, 3, 4, 5]</b>.</li></ul>

<h2 class="bg-gray-800 p-5 text-zing-100 text-xl mt-5">Learn more about the powerful <a href="../docs/console_built_in.html">built-in commands</a>.</h2>
<h2 class="bg-gray-800 p-5 text-zing-100 text-zing-100 text-xl">Learn how to write your own <a href="../docs/console_custom.html">custom commands</a>.</h2>

<h2 class="text-zing-100 text-xl mt-5">Running Scripts</h2>
<p>You can automate the Proxima Console to run commands in sequence. This might be helpful if you need to read many values repeatedly or setup a scene in a predefined way.</p>
<ul class="list-disc ml-5"><li>Create a text file with a list of commands, one per line. Blank lines are ignored.</li>
   <li>Click &quot;Run Script&quot; in the console and select your file. The console will run each command in sequence.</li></ul>

<img class="self-start" src="../docs/run-script.png" alt="Run Script button"></div></div></div>
</div>
        <div class="h-[200px] flex flex-col"><p class="text-gray-400 m-10">© 2023 Virtual Maker Corporation</p></div></div></div>


		
	</div>
	</body>
</html>
